package com.gaoshi.chapter4;

/**
 * 类注释
 * A {@code Card} object represents a playing card, such
 * as "Queen of Hearts". A card has a suit (Diamond, Heart,
 * Spade or Club), and a value (1 = Ace, 2 ... 10, 11 = Jack,
 * 12 = Queen, 13 = King)
 */
public class DocumentationComments {
    /**
     * 字段注释，只需要对公共字段（通常是只静态常量）建立文档
     * The "Hearts" card suit
     */
    public static final int HEARTS = 1;

    /**
     * 方法注释
     * Raise the salary of an employee.
     * @param byPercent the percentage by which to raise the salary (e.g., 10 means 10%)
     * @return the amount of the raise
     */
    public double raiseSalary(double byPercent) {
        return 0.0;
    }
}
